Collection prefix support for MongoDB job repository #5031
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SHINMH
changed the title
- Add collectionPrefix parameter to EnableMongoJobRepository annotation - Update MongoDB DAO classes to support configurable collection names - Maintain backward compatibility with default "BATCH_" prefix Signed-off-by: Myeongha Shin <[email protected]>
SHINMH
changed the title
gyuyeol
reviewed
Oct 31, 2025
Comment on lines
+61
to
+67
| mongoTemplate.createCollection("BATCH_SEQUENCES"); | ||
| mongoTemplate.getCollection("BATCH_SEQUENCES") | ||
| .insertOne(new Document(Map.of("_id", PREFIX + "JOB_INSTANCE_SEQ", "count", 0L))); | ||
| mongoTemplate.getCollection("BATCH_SEQUENCES") | ||
| .insertOne(new Document(Map.of("_id", PREFIX + "JOB_EXECUTION_SEQ", "count", 0L))); | ||
| mongoTemplate.getCollection("BATCH_SEQUENCES") | ||
| .insertOne(new Document(Map.of("_id", PREFIX + "STEP_EXECUTION_SEQ", "count", 0L))); |
There was a problem hiding this comment.
The BATCH_SEQUENCES collection should also have a prefix. Otherwise, batch jobs with different prefixes will end up sharing the same collection. I understand that it works correctly due to the prefix on the document ID. However, using the same collection will likely cause confusion.
Also, class MongoSequenceIncrementer needs to be modified to apply the prefix. This class also has the BATCH_SEQUENCES collection hardcoded.
Comment on lines
+59
to
+60
| this.jobExecutionIncrementer = new MongoSequenceIncrementer(mongoOperations, | ||
| collectionPrefix + JOB_EXECUTIONS_SEQUENCE_NAME); |
There was a problem hiding this comment.
It would be great if we could pass the collectionPrefix as a parameter and use it internally as a prefix for both the collection name and the sequence ID.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Description
This PR adds collection prefix support for MongoDB job repository, mirroring the existing tablePrefix functionality in JDBC job repository. This enables multi-application support, environment isolation, and easier management of MongoDB collections in Spring Batch deployments.
🎯 Motivation
Currently, MongoDB job repository uses hardcoded collection names (BATCH_JOB_INSTANCE, BATCH_JOB_EXECUTION, etc.), making it difficult to:
Run multiple Spring Batch applications against the same MongoDB database
Isolate different environments (dev, test, prod)
Manage collections with custom naming conventions
🔧 Changes
EnableMongoJobRepository: Add collectionPrefix parameter (defaults to "BATCH_")
MongoJobRepositoryFactoryBean: Add collection prefix support
MongoDB DAO classes: Support configurable collection names via constructor parameters
BatchRegistrar: Pass collection prefix from annotation to factory bean
Tests: Add integration tests for collection prefix functionality
💡 Usage Example
This will create collections like:
MY_APP_JOB_INSTANCE
MY_APP_JOB_EXECUTION
MY_APP_STEP_EXECUTION
Closes: collectionPrefix for MongoDB Job repository #4980